# Q. What is this file?
# A. This file contains options which allow you to configure your multiworld experience while allowing
#    others to play how they want as well.
#
# Q. How do I use it?
# A. The options in this file are weighted. This means the higher number you assign to a value, the
#    more chances you have for that option to be chosen. For example, an option like this:
#
#    map_shuffle:
#      on: 5
#      off: 15
#
#    Means you have 5 chances for map shuffle to occur, and 15 chances for map shuffle to be turned
#    off.
#
# Q. I've never seen a file like this before. What characters am I allowed to use?
# A. This is a .yaml file. You are allowed to use most characters.
#    To test if your yaml is valid or not, you can use this website:
#        http://www.yamllint.com/
#    You can also verify that your Archipelago options are valid at this site:
#        https://archipelago.gg/check

# Your name in-game, limited to 16 characters.
#     {player} will be replaced with the player's slot number.
#     {PLAYER} will be replaced with the player's slot number, if that slot number is greater than 1.
#     {number} will be replaced with the counter value of the name.
#     {NUMBER} will be replaced with the counter value of the name, if the counter value is greater than 1.
name: Player{number}

# Used to describe your yaml. Useful if you have multiple files.
description: Default Donut County Template

game: Donut County
requires:
  version: 0.6.7 # Version of Archipelago required for this yaml to work as expected.
  game:
    Donut County: 0.1.1 # Version of the world required for this yaml to work as expected.

Donut County:
  ################
  # Game Options #
  ################
  goal_area:
    # The game will goal upon entering Aftermath.
    # - bossfight: Unlock and complete the Boss Fight level to unlock Aftermath
    # - aftermath: Quadcopter Pieces directly unlock Aftermath
    bossfight: 50
    aftermath: 0

  total_pieces:
    # How many Quadcopter Pieces to add to the item pool.
    # There may be fewer than this depending on the number of free locations.
    # See the note on the game info page about `start_inventory` behavior.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 100
    40: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-100: 0 # random value between 0 and 100

  pieces_required_percent:
    # Percentage of total Quadcopter Pieces that need to be collected to unlock the goal area.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 100
    80: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-100: 0 # random value between 0 and 100

  pieces_unlock_levels:
    # Start with a single area unlocked, Quadcopter Pieces progressively unlock more areas in a shuffled order.
    # **Likely to cause generation errors.**
    'false': 50
    'true': 0

  ################
  # Item Options #
  ################
  levels:
    # Require items to be able to access each level. Add a level to `start_inventory` so you can do something at the start of the game. (20-21 items)
    # **Likely to cause generation errors.**
    'false': 50
    'true': 0

  hole:
    # - off: Hole contents always have effects.
    # - global: Require an item to have effects from hole contents. (1 item)
    # - split: Require items to have effects from each individual type of hole contents. (5 items)
    'off': 0
    global: 0
    split: 50

  catapult:
    # - off: Catapult is always available.
    # - global: Require an item to use the catapult. (1 item)
    # - split: Require items to launch specific kinds of object. (11 items)
    'off': 0
    global: 50
    split: 0

  texting:
    # Require an item to be able to send text messages. (1 item)
    'false': 50
    'true': 0

  ####################
  # Location Options #
  ####################
  achievements:
    # Location for each non-postgame achievement. (16 locations)
    'false': 50
    'true': 0

  buy_catapult:
    # Location when purchasing the catapult. (1 location)
    'false': 50
    'true': 0

  snake_danger:
    # Ranger Station snake danger is randomized. (4 locations, 4 items)
    'false': 50
    'true': 0

  salt_and_pepper:
    # Cat Soup shakers will give locations, Progressive Salt & Pepper unlock progression. (5 locations, 5 items)
    'false': 50
    'true': 0

  #################
  # Trash Options #
  #################
  filler_weights:
    # If there's too many locations, add some filler!
    # - filler: Does (basically) nothing.
    # - concrete_trap: Disables your hole for a short period.
    # - depths_trap: Takes you 999ft below Donut County for a random cutscene.
    concrete_trap: 2
    depths_trap: 1
    filler: 7

  ###########################
  # Item & Location Options #
  ###########################
  local_items:
    # Forces these items to be in their native world.
    []

  non_local_items:
    # Forces these items to be outside their native world.
    []

  start_inventory:
    # Start with the specified amount of these items. Example: "Bomb: 1"
    {}

  start_inventory_from_pool:
    # Start with the specified amount of these items and don't place them in the world. Example: "Bomb: 1"
    # 
    # The game decides what the replacement items will be.
    {}

  start_hints:
    # Start with these item's locations prefilled into the ``!hint`` command.
    []

  start_location_hints:
    # Start with these locations and their item prefilled into the ``!hint`` command.
    []

  exclude_locations:
    # Prevent these locations from having an important item.
    []

  priority_locations:
    # Prevent these locations from having an unimportant item.
    []

  item_links:
    # Share part of your item pool with other players.
    []

  plando_items:
    # Generic items plando.
    []
